vcQuantity
Basic implementation for quantities used in the application and provides access to units.
See in: Overview
Module: vcCore
Parent: vcObject
Children: vcScalarQuantity, vcVectorQuantity
Referenced by: vcMatrixProperty.Quantity, vcMatrixStepProperty.Quantity, vcRealExpressionProperty.Quantity, vcRealLimitProperty.Quantity, ... (see more)
vcMatrixProperty.Quantity
vcMatrixStepProperty.Quantity
vcRealExpressionProperty.Quantity
vcRealLimitProperty.Quantity
vcRealProperty.Quantity
vcRealStepProperty.Quantity
vcUnitGroup.Quantity
vcUnitManager.createQuantity()
vcUnitManager.findQuantity()
vcVectorProperty.Quantity
vcVectorStepProperty.Quantity
Properties
Learn how to use properties here. The properties are also inherited from the parent class.
| Name | Type | Access | Description |
| AvailableGroups | vcList[vcUnitGroup] | R | Gets a list of all unit groups that include the quantity, thereby any one of those groups can be used to access and select quantity. |
| CurrentGroup | vcUnitGroup | RW | Gets or sets the current unit group used for listing the quantity's properties. If value is None and quantity has a parent quality, uses the current group of parent. |
| EffectiveGroup | vcUnitGroup | R | Gets the actual unit group used for listing the quantity's properties. If current group is None, uses unit group of parent quantity. |
| FullName | String | R | Gets the full name of quantity, which is the concatenation of parent quantity names with a dot (.) separator and Name. You can refer to a quantity by referencing its full name. |
| IsBuiltIn | Boolean | R | Gets if quantity is a built-in quantity which cannot be edited nor destroyed. |
| Name | String | RW | Gets or sets the quantity's name. |
| Type | vcQuantityKind | R | Gets the quantity type. |
Methods
Learn how to use methods here. The methods are also inherited from the parent class.
| Name | Return Type | Parameters | Description |
| delete | None | None | Deletes the quantity. Exceptions: RuntimeError: When deleting a built-in unit quantity object. |